<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.bukkit.plugin;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import com.avaje.ebean.EbeanServer;<a name="line.3"></a>
<FONT color="green">004</FONT>    import java.io.File;<a name="line.4"></a>
<FONT color="green">005</FONT>    import org.bukkit.Server;<a name="line.5"></a>
<FONT color="green">006</FONT>    import org.bukkit.command.CommandExecutor;<a name="line.6"></a>
<FONT color="green">007</FONT>    import org.bukkit.generator.ChunkGenerator;<a name="line.7"></a>
<FONT color="green">008</FONT>    import org.bukkit.util.config.Configuration;<a name="line.8"></a>
<FONT color="green">009</FONT>    <a name="line.9"></a>
<FONT color="green">010</FONT>    /**<a name="line.10"></a>
<FONT color="green">011</FONT>     * Represents a Plugin<a name="line.11"></a>
<FONT color="green">012</FONT>     */<a name="line.12"></a>
<FONT color="green">013</FONT>    public interface Plugin extends CommandExecutor {<a name="line.13"></a>
<FONT color="green">014</FONT>    <a name="line.14"></a>
<FONT color="green">015</FONT>        /**<a name="line.15"></a>
<FONT color="green">016</FONT>         * Returns the folder that the plugin data's files are located in. The<a name="line.16"></a>
<FONT color="green">017</FONT>         * folder may not yet exist.<a name="line.17"></a>
<FONT color="green">018</FONT>         *<a name="line.18"></a>
<FONT color="green">019</FONT>         * @return<a name="line.19"></a>
<FONT color="green">020</FONT>         */<a name="line.20"></a>
<FONT color="green">021</FONT>        public File getDataFolder();<a name="line.21"></a>
<FONT color="green">022</FONT>    <a name="line.22"></a>
<FONT color="green">023</FONT>        /**<a name="line.23"></a>
<FONT color="green">024</FONT>         * Returns the plugin.yaml file containing the details for this plugin<a name="line.24"></a>
<FONT color="green">025</FONT>         *<a name="line.25"></a>
<FONT color="green">026</FONT>         * @return Contents of the plugin.yaml file<a name="line.26"></a>
<FONT color="green">027</FONT>         */<a name="line.27"></a>
<FONT color="green">028</FONT>        public PluginDescriptionFile getDescription();<a name="line.28"></a>
<FONT color="green">029</FONT>    <a name="line.29"></a>
<FONT color="green">030</FONT>        /**<a name="line.30"></a>
<FONT color="green">031</FONT>         * Returns the main configuration file. It should be loaded.<a name="line.31"></a>
<FONT color="green">032</FONT>         *<a name="line.32"></a>
<FONT color="green">033</FONT>         * @return<a name="line.33"></a>
<FONT color="green">034</FONT>         */<a name="line.34"></a>
<FONT color="green">035</FONT>        public Configuration getConfiguration();<a name="line.35"></a>
<FONT color="green">036</FONT>    <a name="line.36"></a>
<FONT color="green">037</FONT>        /**<a name="line.37"></a>
<FONT color="green">038</FONT>         * Gets the associated PluginLoader responsible for this plugin<a name="line.38"></a>
<FONT color="green">039</FONT>         *<a name="line.39"></a>
<FONT color="green">040</FONT>         * @return PluginLoader that controls this plugin<a name="line.40"></a>
<FONT color="green">041</FONT>         */<a name="line.41"></a>
<FONT color="green">042</FONT>        public PluginLoader getPluginLoader();<a name="line.42"></a>
<FONT color="green">043</FONT>    <a name="line.43"></a>
<FONT color="green">044</FONT>        /**<a name="line.44"></a>
<FONT color="green">045</FONT>         * Returns the Server instance currently running this plugin<a name="line.45"></a>
<FONT color="green">046</FONT>         *<a name="line.46"></a>
<FONT color="green">047</FONT>         * @return Server running this plugin<a name="line.47"></a>
<FONT color="green">048</FONT>         */<a name="line.48"></a>
<FONT color="green">049</FONT>        public Server getServer();<a name="line.49"></a>
<FONT color="green">050</FONT>    <a name="line.50"></a>
<FONT color="green">051</FONT>        /**<a name="line.51"></a>
<FONT color="green">052</FONT>         * Returns a value indicating whether or not this plugin is currently enabled<a name="line.52"></a>
<FONT color="green">053</FONT>         *<a name="line.53"></a>
<FONT color="green">054</FONT>         * @return true if this plugin is enabled, otherwise false<a name="line.54"></a>
<FONT color="green">055</FONT>         */<a name="line.55"></a>
<FONT color="green">056</FONT>        public boolean isEnabled();<a name="line.56"></a>
<FONT color="green">057</FONT>    <a name="line.57"></a>
<FONT color="green">058</FONT>        /**<a name="line.58"></a>
<FONT color="green">059</FONT>         * Called when this plugin is disabled<a name="line.59"></a>
<FONT color="green">060</FONT>         */<a name="line.60"></a>
<FONT color="green">061</FONT>        public void onDisable();<a name="line.61"></a>
<FONT color="green">062</FONT>    <a name="line.62"></a>
<FONT color="green">063</FONT>        /**<a name="line.63"></a>
<FONT color="green">064</FONT>         * Called after a plugin is loaded but before it has been enabled.<a name="line.64"></a>
<FONT color="green">065</FONT>         * When mulitple plugins are loaded, the onLoad() for all plugins is called before any onEnable() is called.<a name="line.65"></a>
<FONT color="green">066</FONT>         */<a name="line.66"></a>
<FONT color="green">067</FONT>        public void onLoad();<a name="line.67"></a>
<FONT color="green">068</FONT>    <a name="line.68"></a>
<FONT color="green">069</FONT>        /**<a name="line.69"></a>
<FONT color="green">070</FONT>         * Called when this plugin is enabled<a name="line.70"></a>
<FONT color="green">071</FONT>         */<a name="line.71"></a>
<FONT color="green">072</FONT>        public void onEnable();<a name="line.72"></a>
<FONT color="green">073</FONT>    <a name="line.73"></a>
<FONT color="green">074</FONT>        /**<a name="line.74"></a>
<FONT color="green">075</FONT>         * Simple boolean if we can still nag to the logs about things<a name="line.75"></a>
<FONT color="green">076</FONT>         * @return boolean whether we can nag<a name="line.76"></a>
<FONT color="green">077</FONT>         */<a name="line.77"></a>
<FONT color="green">078</FONT>        public boolean isNaggable();<a name="line.78"></a>
<FONT color="green">079</FONT>    <a name="line.79"></a>
<FONT color="green">080</FONT>        /**<a name="line.80"></a>
<FONT color="green">081</FONT>         * Set naggable state<a name="line.81"></a>
<FONT color="green">082</FONT>         * @param canNag is this plugin still naggable?<a name="line.82"></a>
<FONT color="green">083</FONT>         */<a name="line.83"></a>
<FONT color="green">084</FONT>        public void setNaggable(boolean canNag);<a name="line.84"></a>
<FONT color="green">085</FONT>    <a name="line.85"></a>
<FONT color="green">086</FONT>        /**<a name="line.86"></a>
<FONT color="green">087</FONT>         * Gets the {@link EbeanServer} tied to this plugin<a name="line.87"></a>
<FONT color="green">088</FONT>         *<a name="line.88"></a>
<FONT color="green">089</FONT>         * @return Ebean server instance<a name="line.89"></a>
<FONT color="green">090</FONT>         */<a name="line.90"></a>
<FONT color="green">091</FONT>        public EbeanServer getDatabase();<a name="line.91"></a>
<FONT color="green">092</FONT>    <a name="line.92"></a>
<FONT color="green">093</FONT>        /**<a name="line.93"></a>
<FONT color="green">094</FONT>         * Gets a {@link ChunkGenerator} for use in a default world, as specified in the server configuration<a name="line.94"></a>
<FONT color="green">095</FONT>         *<a name="line.95"></a>
<FONT color="green">096</FONT>         * @param worldName Name of the world that this will be applied to<a name="line.96"></a>
<FONT color="green">097</FONT>         * @param id Unique ID, if any, that was specified to indicate which generator was requested<a name="line.97"></a>
<FONT color="green">098</FONT>         * @return ChunkGenerator for use in the default world generation<a name="line.98"></a>
<FONT color="green">099</FONT>         */<a name="line.99"></a>
<FONT color="green">100</FONT>        public ChunkGenerator getDefaultWorldGenerator(String worldName, String id);<a name="line.100"></a>
<FONT color="green">101</FONT>    }<a name="line.101"></a>




























































</PRE>
</BODY>
</HTML>
